Skip to content

polish: Fix some inconsistencies in object names and messages #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 3 commits into
base: 4.20
Choose a base branch
from
Draft

polish: Fix some inconsistencies in object names and messages #506

wants to merge 3 commits into from

Conversation

abh1sar
Copy link
Contributor

@abh1sar abh1sar commented May 19, 2025 •
edited by github-actions bot
Loading

Documentation PR for apache/cloudstack#10856

ACL Lists

  1. Replace ACL Lists with ACLs as Access Control List Lists doesn't make sense
  2. Replace Add ACL with Add ACL rule wherever a rule is being added

User data

  1. Following industry conventions, User data should be written as two words
  2. The term "User Data" used in the main menu creates some confusion, whether it is singular or plural. So renamed it to "User Data Library" where users can register new User Data.
  3. User data should not be followed by "a"

📚 Documentation preview 📚: https://cloudstack-documentation--506.org.readthedocs.build/en/506/

@abh1sar abh1sar mentioned this pull request May 19, 2025
Draft
14 tasks
DaanHoogland
DaanHoogland reviewed Jun 3, 2025
View reviewed changes
Copy link
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

general remark; user data, User data and User Data seem to be used interchangably. maybe cleanup?
also I suggest a global replace of "ACL rule" with "access rule"

source/adminguide/networking/virtual_private_cloud_config.rst Outdated
Comment on lines 318 to 319
About Network ACLs
^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
About Network ACLs
^^^^^^^^^^^^^^^^^^^^^^^
About Network ACLs
^^^^^^^^^^^^^^^^^^

source/adminguide/networking/virtual_private_cloud_config.rst Outdated
Comment on lines 360 to 361
Creating ACLs
^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Creating ACLs
^^^^^^^^^^^^^^^^^^
Creating ACLs
^^^^^^^^^^^^^

source/adminguide/networking/virtual_private_cloud_config.rst Outdated
Comment on lines 474 to 475
Creating a Tier with Custom ACL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Creating a Tier with Custom ACL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Creating a Tier with Custom ACL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

source/adminguide/networking/virtual_private_cloud_config.rst Outdated
Comment on lines 490 to 491
Assigning a Custom ACL to a Tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Assigning a Custom ACL to a Tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Assigning a Custom ACL to a Tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

source/adminguide/virtual_machines/user-data.rst Outdated
Comment on lines 125 to 126
Storing and accessing user data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Storing and accessing user data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Storing and accessing user data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/plugins/ipv6.rst
@@ -343,4 +343,4 @@ IPv6 ACL rules for an IPv6 supported VPC Network Tier can be managed using Netwo
.. |add-ipv6-acl-rule-form.png| image:: /_static/images/add-ipv6-acl-rule-form.png
:alt: Add IPv6 ACL rule.
.. |ipv6-acl-list.png| image:: /_static/images/ipv6-acl-list.png
:alt: IPv6 ACL rule in Network ACL list.
:alt: IPv6 ACL rule in Network ACL.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:alt: IPv6 ACL rule in Network ACL.
:alt: IPv6 access rule in Network ACL.

??

@abh1sar
Copy link
Contributor Author

abh1sar commented Jun 6, 2025

@blueorangutan docbuild

@blueorangutan
Copy link

@abh1sar a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.

@blueorangutan
Copy link

QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/506. (QA-JID 358)

@abh1sar
Copy link
Contributor Author

abh1sar commented Jun 6, 2025

general remark; user data, User data and User Data seem to be used interchangably. maybe cleanup? also I suggest a global replace of "ACL rule" with "access rule"

Thanks for the review @DaanHoogland
I have cleaned up user data (there were also many instances where 'user-data' was being used. Have replaced it with 'user data'). Also, I had missed updating the screenshots earlier.

I’m not entirely convinced about using “access rule”. It feels like a more generic term and might be unclear without proper context. Other platforms, like AWS, use the term “ACL rules,” so I’d prefer to stick with that for clarity and consistency.
https://docs.aws.amazon.com/vpc/latest/userguide/nacl-rules.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DaanHoogland DaanHoogland DaanHoogland left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@abh1sar @blueorangutan @DaanHoogland